home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 November / SGI Freeware 1999 November - Disc 2.iso / dist / fw_JSmcvert.idb / usr / freeware / catman / u_man / cat1 / mcvert.z / mcvert
Text File  |  1997-09-09  |  20KB  |  463 lines

  1.  
  2.  
  3.  
  4.      MMMMCCCCVVVVEEEERRRRTTTT((((LLLLOOOOCCCCAAAALLLL))))      UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    ((((11110000NNNNoooovvvv99993333))))     MMMMCCCCVVVVEEEERRRRTTTT((((LLLLOOOOCCCCAAAALLLL))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       mcvert - MacBinary <=> BinHex    4.0 and    more file conversion
  10.       utility
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.       mmmmccccvvvveeeerrrrtttt { [option] ...    name ... } ...
  14.  
  15.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.       The _m_c_v_e_r_t program translates    files between MacBinary    format
  17.       and other formats often used in exchanging Macintosh files.
  18.       See _F_I_L_E _F_O_R_M_A_T_S below for a description of the file formats
  19.       supported.
  20.  
  21.      PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  22.       The defaults for the parameters are -xxxxDDDDqqqqvvvv:  convert BinHex
  23.       4.0 files (xxxx)    to MacBinary files (DDDD),    bypass automatic
  24.       unpacking of PIT files (qqqq), and provide a verbose level of
  25.       output (vvvv).
  26.  
  27.      OOOOPPPPTTTTIIIIOOOONNNNSSSS
  28.       All the options, other than _F_O_R_M_A_T _O_P_T_I_O_N_S described below,
  29.       are listed here.  From each set, one and only    one
  30.       alternative is active    for any    one file.
  31.  
  32.       UUUU |||| DDDD
  33.            When option -U, as in Upload, is    selected, the
  34.            conversion is from MacBinary to something else.
  35.            Conversely, option -D, as in Download, selects
  36.            conversion from something to MacBinary.
  37.  
  38.       pppp |||| qqqq
  39.            If a BinHex 4.0 to MacBinary conversion is taking place
  40.            and option -p, as in Pit, is selected, any file of type
  41.            "PIT " will be unpacked into its    constituent parts.
  42.            This option does    not recursively    unpack "PIT " files
  43.            packed in "PIT "    files.    If a MacBinary to BinHex 4.0
  44.            conversion is taking place, this    option is currently
  45.            ignored.     Conversely, option -q,    as in Quiescent, does
  46.            no such unpacking.
  47.  
  48.       tttt    Macintosh and UNIX differ in the    end-of-line character
  49.            they use.  Option -t, as    in Translate, enables end-of-
  50.            line character translation for the data.     Translation
  51.            is off by default, but it is enabled automatically when
  52.            processing -u (Usual Text) files.  Option -t is useful
  53.            when processing both data and resource files at the
  54.            same time (option -b) to    enable end-of-line character
  55.            translation for the data.
  56.  
  57.       SSSS |||| ssss    |||| vvvv |||| VVVV    |||| VVVVVVVV
  58.            Normally, _m_c_v_e_r_t    prints converting messages and other
  59.            information about the files it is processing to stderr.
  60.  
  61.  
  62.  
  63.      Page 1                         (printed 12/8/95)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      MMMMCCCCVVVVEEEERRRRTTTT((((LLLLOOOOCCCCAAAALLLL))))      UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    ((((11110000NNNNoooovvvv99993333))))     MMMMCCCCVVVVEEEERRRRTTTT((((LLLLOOOOCCCCAAAALLLL))))
  71.  
  72.  
  73.  
  74.            Option -S, as in    SILENT,    disables all such reporting.
  75.            Option -s, as in    Silent,    disables all but the
  76.            "Converting ..."    messages.  Option -v, as in Verbose,
  77.            emits generally useful information.  Option -V, as in
  78.            VERBOSE,    displays some additional debugging
  79.            information.  Option -VV, as in VERY VERBOSE, displays
  80.            detailed    debugging information as well.
  81.  
  82.       HHHH    Option -H, as in    Heuristic, disables the    skip-legal-
  83.            but-suspect-lines heuristic used    when processing    BinHex
  84.            4.0 formatted input files.  See _B_U_G_S below for details
  85.            on the heuristic.
  86.  
  87.       IIII    Option -I, as in    Information only, does not write
  88.            output files, but does indicate which output files
  89.            would normally be written.  All other operations    are
  90.            performed, including verifying file formats and
  91.            calculated CRC values.  The -I option basically
  92.            provides    a non-destructive verification of the files
  93.            and their processing.  It is also a soothing balm for
  94.            the somewhat paranoid, since it reports what files
  95.            would be    changed, without actually changing them.
  96.  
  97.       PPPP    Option -P, as in    Pipe output to stdout, writes the
  98.            resulting output    file(s)    to stdout, rather than to the
  99.            file system with    the appropriate    extension.  The
  100.            default is to use the file system.
  101.  
  102.      FFFFIIIILLLLEEEE FFFFOOOORRRRMMMMAAAATTTTSSSS
  103.       Some useful formats in which Macintosh files are represented
  104.       on non-Macs are:
  105.  
  106.       MMMMaaaaccccBBBBiiiinnnnaaaarrrryyyy::::
  107.            An eight    bit wide representation    of the data and
  108.            resource    forks of a Mac file and    of relevant Finder
  109.            information, MacBinary files are    recognized as
  110.            "special" by several Macintosh terminal emulators.
  111.            These emulators,    using kermit or    xmodem or other    file
  112.            transfer    protocols, can separate    the incoming file into
  113.            forks and appropriately modify the Desktop to display
  114.            icons, types, creation dates, and the like.
  115.  
  116.       BBBBiiiinnnnHHHHeeeexxxx 4444....0000::::
  117.            A seven bit wide    representation of a Mac    file with CRC
  118.            error checking, BinHex 4.0 files    are designed for
  119.            communication of    Mac files over long distance, possibly
  120.            noisy, seven bit    wide paths.
  121.  
  122.       PPPPaaaacccckkkkIIIItttt::::
  123.            PackIt files are    actually representations of
  124.            collections of Mac files, possibly Huffman compressed.
  125.            Packing many small related files    together before    a
  126.  
  127.  
  128.  
  129.      Page 2                         (printed 12/8/95)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      MMMMCCCCVVVVEEEERRRRTTTT((((LLLLOOOOCCCCAAAALLLL))))      UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    ((((11110000NNNNoooovvvv99993333))))     MMMMCCCCVVVVEEEERRRRTTTT((((LLLLOOOOCCCCAAAALLLL))))
  137.  
  138.  
  139.  
  140.            MacBinary transfer or a translation to BinHex 4.0 is
  141.            common practice.
  142.  
  143.       TTTTeeeexxxxtttt::::
  144.            A Macintosh ends    each line of a plain text file with a
  145.            carriage    return character (^M), rather than the newline
  146.            character (^J) that some    systems    require    (for example,
  147.            UNIX).  Moreover, a MacBinary file has prepended    Finder
  148.            information that    non-Macintoshes    usually    don't expect.
  149.  
  150.       DDDDaaaattttaaaa,,,,    RRRRssssrrrrcccc::::
  151.            A Data or Rsrc file is the exact    copy of    the data or
  152.            resource    fork of    a Macintosh file.
  153.  
  154.      FFFFOOOORRRRMMMMAAAATTTT OOOOPPPPTTTTIIIIOOOONNNNSSSS
  155.       Exactly one of the following selections may be specified for
  156.       an input name:
  157.  
  158.       xxxx    BinHex 4.0 [.hqx] - files in the    MacBinary format are
  159.            translated to BinHex 4.0    files, or vice versa.  The
  160.            name argument is    the name of a file to be converted.
  161.            If the conversion is from BinHex    4.0 to MacBinary,
  162.            several files may comprise the BinHex 4.0
  163.            representation of the Mac file.    Rather than manually
  164.            concatenate the files and manually delete mail headers
  165.            and other extraneous garbage, one may specify the names
  166.            of the files in order and _m_c_v_e_r_t    will do    the
  167.            concatenating and deleting.  Conversely,    in converting
  168.            a MacBinary file    to BinHex 4.0 format for mailing over
  169.            long distances, one may be restricted to    mail messages
  170.            of no greater that some fixed length.  In this case,
  171.            _m_c_v_e_r_t can automatically    divide the BinHex 4.0 file
  172.            into pieces and label each piece    appropriately.    For
  173.            details on automatically    segmenting files, see the
  174.            description of the MMMMAAAACCCC____LLLLIIIINNNNEEEE____LLLLIIIIMMMMIIIITTTT environment variable
  175.            below.
  176.  
  177.       uuuu |||| hhhh
  178.            Text [.text] - files in the MacBinary format with
  179.            nonempty    data forks and empty resource forks are    made
  180.            from ordinary data files, or vice versa.     Option    -u,
  181.            for Usual Text, performs    translation.  Option -h, for
  182.            Host Text, performs no translation.  When translating,
  183.            UNIX newline characters are interchanged    with Macintosh
  184.            carriage    return characters.
  185.  
  186.       dddd    Data [.data] - files in the MacBinary format with
  187.            nonempty    data forks and empty resource forks are    made
  188.            from ordinary data files, or vice versa.     If the    data
  189.            is really text, you should use -u or -h so that the
  190.            file type and creator get set correctly.
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                         (printed 12/8/95)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      MMMMCCCCVVVVEEEERRRRTTTT((((LLLLOOOOCCCCAAAALLLL))))      UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    ((((11110000NNNNoooovvvv99993333))))     MMMMCCCCVVVVEEEERRRRTTTT((((LLLLOOOOCCCCAAAALLLL))))
  203.  
  204.  
  205.  
  206.       rrrr    Resource    [.rsrc]    - files    in the MacBinary format    with
  207.            empty data forks    and nonempty resource forks are    made
  208.            from ordinary data files, or vice versa.
  209.  
  210.       bbbb    Both [.data .rsrc] - files in the MacBinary format with
  211.            nonempty    data forks and and nonempty resource forks are
  212.            made from ordinary data files, or vice versa.  For
  213.            option -b processing, a single base file    name is
  214.            provided, and the ".data" and ".rsrc" extensions    are
  215.            supplied    by _m_c_v_e_r_t.
  216.  
  217.      FFFFIIIILLLLEEEE NNNNAAAAMMMMEEEESSSS    AAAANNNNDDDD EEEEXXXXTTTTEEEENNNNSSSSIIIIOOOONNNNSSSS
  218.       _m_c_v_e_r_t uses certain file extensions when reading and writing
  219.       files.  These    extensions are indicated in the    "FORMAT
  220.       OPTIONS" section above.  For example,    the appropriate
  221.       extension for    a BinHex 4.0 file is ".hqx".
  222.  
  223.       For input files, _m_c_v_e_r_t first    tries to open the file using
  224.       the specified    name.  If that fails, _m_c_v_e_r_t appends the
  225.       appropriate suffix (if not already present) and tries    again.
  226.       Recall that for option -b (Both) processing, a single    base
  227.       file name must be provided, since the    ".data"    and ".rsrc"
  228.       extensions are appended automatically    by _m_c_v_e_r_t.  For
  229.       example, "mcvert foo"    will try to open "foo",    and failing
  230.       that,    try to open "foo.hqx" for input; while "mcvert -b foo"
  231.       will open only "foo.data" and    "foo.rsrc" for input.
  232.  
  233.       For output files, _m_c_v_e_r_t always uses the specified base file
  234.       name and appropriate extension.  For MacBinary and BinHex
  235.       4.0 input files, the base file name is specified within the
  236.       input    file, while for    plain files, the file name specified
  237.       on the command line is used.    The appropriate    extension is
  238.       based    on the conversion, or on the MAC_EXT environment
  239.       variable for MacBinary output    files.    For example, if    there
  240.       is text file named foo.text (but no file named foo), "mcvert
  241.       -u foo" will use foo.text as input, and generate a file
  242.       called "foo.bin", while "mcvert -u foo.text" will use
  243.       foo.text as input, and generate a file called
  244.       "foo.text.bin".
  245.  
  246.      EEEENNNNVVVVIIIIRRRROOOONNNNMMMMEEEENNNNTTTT VVVVAAAARRRRIIIIAAAABBBBLLLLEEEESSSS AAAANNNNDDDD DDDDEEEEFFFFAAAAUUUULLLLTTTTSSSS
  247.       There    are five environment variables one may use to
  248.       customize the    behavior of _m_c_v_e_r_t slightly.
  249.  
  250.       MMMMAAAACCCC____FFFFIIIILLLLEEEETTTTYYYYPPPPEEEE
  251.            The file    type of    a MacBinary file converted from    non
  252.            BinHex 4.0 inputs is set    to this    four-character
  253.            sequence.  For example, one might set this variable to
  254.            "PICT" when converting files created by ppmtopict(1).
  255.            The default is "TEXT" for Text or Host inputs, and
  256.            "????" otherwise.  BinHex 4.0 inputs specify the    file
  257.            type to use internally.
  258.  
  259.  
  260.  
  261.      Page 4                         (printed 12/8/95)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      MMMMCCCCVVVVEEEERRRRTTTT((((LLLLOOOOCCCCAAAALLLL))))      UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    ((((11110000NNNNoooovvvv99993333))))     MMMMCCCCVVVVEEEERRRRTTTT((((LLLLOOOOCCCCAAAALLLL))))
  269.  
  270.  
  271.  
  272.       MMMMAAAACCCC____EEEEDDDDIIIITTTTOOOORRRR
  273.            The creator type    (author) of MacBinary files is set to
  274.            this four-character sequence.  The default is "MACA"
  275.            (the creator type of MacWrite) for Text inputs, and
  276.            "????" otherwise.  BinHex 4.0 inputs specify the
  277.            creator type to use internally.
  278.  
  279.       MMMMAAAACCCC____DDDDLLLLOOOOAAAADDDD____DDDDIIIIRRRR
  280.            The MacBinary files created when    option -D is selected
  281.            are placed in this directory.  The default is ".", the
  282.            current working directory.
  283.  
  284.       MMMMAAAACCCC____EEEEXXXXTTTT
  285.            The MacBinary files created when    option -D is selected
  286.            are named according to the file name field stored in
  287.            the file    header,    with the name extended by this suffix.
  288.            The default is ".bin".
  289.  
  290.       MMMMAAAACCCC____LLLLIIIINNNNEEEE____LLLLIIIIMMMMIIIITTTT
  291.            The BinHex 4.0 files created when option    -U is selected
  292.            may be no longer    than this many lines long.  Files that
  293.            would otherwise exceed this line    limit are broken up
  294.            into several files with numbers embedded    into their
  295.            file names to show their    order.    Each such file has
  296.            "Start of part x" and "End of part x" messages included
  297.            where appropriate.
  298.  
  299.      BBBBUUUUGGGGSSSS
  300.       _m_c_v_e_r_t silently discards input lines which are not
  301.       completely valid.  Therefore,    error indications for
  302.       illegally formatted files are    likely to be somewhat obtuse,
  303.       often    with just a CRC    mismatch message.
  304.  
  305.       In order to handle files (such as segmented
  306.       comp.binaries.mac files) which have extraneous but valid
  307.       BinHex 4.0 lines (such as  "---"), _m_c_v_e_r_t uses the following
  308.       heuristic to discard suspect but legal lines in BinHex 4.0
  309.       formatted input files.  When a new file is opened, or    when
  310.       invalid lines    are found, the search for good data begins.
  311.       While    searching for good data, if a line is too short    (less
  312.       than 12 characters), or if a line is just a single repeated
  313.       character, the line is discarded.  Once _m_c_v_e_r_t starts
  314.       processing good data,    no valid lines are discarded.  Thus,
  315.       this heuristic can also discard (unusually formatted)    valid
  316.       and intended BinHex 4.0 lines.  While    there is no way    to
  317.       tune the heuristic (other than modifying the program and
  318.       recompiling),    the heuristic can be completely    disabled with
  319.       the ----HHHH option.  So if    you run    into problems, put all the
  320.       relevant lines into one file,    edit the file to remove    any
  321.       extraneous lines, and    invoke _m_c_v_e_r_t with the ----HHHH option.
  322.  
  323.       It should be possible    to discard bad input now and
  324.  
  325.  
  326.  
  327.      Page 5                         (printed 12/8/95)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      MMMMCCCCVVVVEEEERRRRTTTT((((LLLLOOOOCCCCAAAALLLL))))      UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    ((((11110000NNNNoooovvvv99993333))))     MMMMCCCCVVVVEEEERRRRTTTT((((LLLLOOOOCCCCAAAALLLL))))
  335.  
  336.  
  337.  
  338.       successfully translate good input later, but bad input
  339.       usually causes immediate termination.
  340.  
  341.       A more diligent person would support BinHex 3.0 and BinHex
  342.       2.0 and BinHex 5000 B. C., but I've never seen or heard of
  343.       anyone using them in years.
  344.  
  345.      OOOOTTTTHHHHEEEERRRR PPPPRRRROOOOGGGGRRRRAAAAMMMMSSSS
  346.       There    are a number of    programs which run on the Mac and
  347.       convert between various Macintosh file formats.  For
  348.       example, here's what info-mac/help/accessing-files.txt, as
  349.       of 13Jun93, has to say about converting between BinHex 4.0
  350.       and native Mac files:
  351.  
  352.            You can also do the conversion on your Macintosh    by
  353.            using any of a number of    utilities, including BinHex
  354.            4.0, StuffIt, or    Compact    Pro. We    recommend using
  355.            Compact Pro because it is slightly more convenient and
  356.            reliable    than the other tools.  Note: do    NOT use    BinHex
  357.            5.0 as it is incompatible, for some very    brain-damaged
  358.            reasons.
  359.  
  360.       CompactPro is    a wonderful piece of shareware.     But if    your
  361.       needs    are limited to expansion of BinHex 4.0 files, StuffIt
  362.       or CompactPro    archives or AppleLink packages,    then the
  363.       freeware StuffIt Expander (v 3.0.3 as    of 28Jul93) may    be
  364.       just what you    want.
  365.  
  366.       There    are other programs available which run under UNIX and
  367.       convert between various Macintosh file formats.  One of
  368.       these    programs may be    what you want to use if    _m_c_v_e_r_t does
  369.       not meet your    needs.    One collection,    called _m_a_c_u_t_i_l,    is
  370.       available from various archives.  Here's what    the
  371.       comp.sys.mac.comm FAQ    (Frequently Asked Questions), Last-
  372.       modified: Sat    Jun 05 1993, has to say    about it:
  373.  
  374.            As of (8/92), macutil includes three programs:
  375.  
  376.            hexbin
  377.             a program to convert BinHex    4.0 to MacBinary; it
  378.             also converts uuencode (and    UULite)    files to their
  379.             native binary format; support for .dl, .hex, and
  380.             .hcx formats (all predecessors of BinHex 4.0) also
  381.             exists
  382.  
  383.            macsave
  384.             a MacBinary    filter program to convert between
  385.             various MacBinary representations, including a
  386.             single .bin    file, three separate .data, .rsrc,
  387.             .info files, and AUFS format. macsave also allows
  388.             one    to "peek" inside MacBinary files
  389.  
  390.  
  391.  
  392.  
  393.      Page 6                         (printed 12/8/95)
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.      MMMMCCCCVVVVEEEERRRRTTTT((((LLLLOOOOCCCCAAAALLLL))))      UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    ((((11110000NNNNoooovvvv99993333))))     MMMMCCCCVVVVEEEERRRRTTTT((((LLLLOOOOCCCCAAAALLLL))))
  401.  
  402.  
  403.  
  404.            macunpack
  405.             a program to unpack    PackIt,    StuffIt, Diamond,
  406.             Compactor/Compact Pro, most    StuffIt    Classic    and
  407.             StuffIt Deluxe, DiskDoubler, Zoom and LHarc/MacLHa
  408.             archives.
  409.  
  410.             It also decodes BinHex 5.0,    MacBinary, uuencode,
  411.             and    UNIX compress (ie: .Z suffix) files (as    well
  412.             as variants    of compress implemented    by various
  413.             Macintosh compress programs).
  414.  
  415.             Support for    password protected and/or multi-
  416.             segment archives of    various    types is minimal or
  417.             non-existent.
  418.  
  419.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  420.       hexbin(1), kermit(1),    macbin(1), macunpack(1), macsave(1),
  421.       macutil(1), ppmtopict(1), sit(1), unsit(1), xbin(1),
  422.       xmodem(1)
  423.  
  424.      AAAAUUUUTTTTHHHHOOOORRRRSSSS
  425.       Doug Moore, Cornell University Computer Science.  Based upon
  426.       _x_b_i_n by Dave Johnson,    Brown University, as modified by Guido
  427.       van Rossum, and upon _u_n_p_i_t by    Allan G. Weber,    as well    as
  428.       upon correspondence with several helpful readers of USENET.
  429.  
  430.       Joseph P. Skudlarek (Jskud@wv.MentorG.com) made numerous
  431.       enhancement and maintenance releases.     See the comments in
  432.       mcvert.c for additional supporting characters.
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.      Page 7                         (printed 12/8/95)
  460.  
  461.  
  462.  
  463.